A value of zero might lead to issues, so a non-zero value is
recommended
(see https://github.com/justbur/emacs-which-key/issues/134)."
- :group 'which-key
:type 'float
:version "1.0")
This makes it possible to shorten the delay for subsequent popups
in the same key sequence. The default is for this value to be
nil, which disables this behavior."
- :group 'which-key
:type '(choice float (const :tag "Disabled" nil))
:version "1.0")
`which-key-show-prefix' is echo. It needs to be less than
`which-key-idle-delay' or else the keystroke echo will erase the
which-key popup."
- :group 'which-key
:type 'float
:version "1.0")
or a function, which takes one argument, the available width in
characters, and whose return value has one of the types mentioned
before. Truncation is done using `which-key-ellipsis'."
- :group 'which-key
:type '(choice (const :tag "Disable truncation" nil)
(integer :tag "Width in characters")
(float :tag "Use fraction of available width")
(defcustom which-key-min-column-description-width 0
"Every column should at least have this width."
- :group 'which-key
:type 'natnum
:version "1.0")
(defcustom which-key-add-column-padding 0
"Additional spaces to add to the left of each key column."
- :group 'which-key
:type 'integer
:version "1.0")
additional ASCII character in the which-key buffer. Increase this
number if you are seeing characters get cutoff on the right side
of the which-key popup."
- :group 'which-key
:type 'integer
:version "1.0")
"If non-nil, don't use any unicode characters in default setup.
For affected settings, see `which-key-replacement-alist', `which-key-ellipsis'
'which-key-separator'."
- :group 'which-key
:type 'boolean
:version "1.0")
"Separator to use between key and description.
Default is \" → \", unless `which-key-dont-use-unicode' is non
nil, in which case the default is \" : \"."
- :group 'which-key
:type 'string
:version "1.0")
Default is \"…\", unless `which-key-dont-use-unicode' is non nil,
in which case the default is \"..\". This can also be the empty
string to truncate without using any ellipsis."
- :group 'which-key
:type 'string
:version "1.0")
(defcustom which-key-prefix-prefix "+"
"Prefix string to indicate a key bound to a keymap.
Default is \"+\"."
- :group 'which-key
:type 'string
:version "1.0")
"If non-nil, show remapped commands.
This applies to commands that have been remapped given the
currently active keymaps."
- :group 'which-key
:type 'boolean
:version "1.0")
Finally, you can multiple replacements to occur for a given key
binding by setting `which-key-allow-multiple-replacements' to a
non-nil value."
- :group 'which-key
:type '(alist :key-type (cons (choice regexp (const nil))
(choice regexp (const nil)))
:value-type (cons (choice string (const nil))
patterns in `which-key-replacement-alist'. When nil, only the
first match is used to perform replacements from
`which-key-replacement-alist'."
- :group 'which-key
:type 'boolean
:version "1.0")
then the command's name with be omitted. You probably also want
to adjust `which-key-max-description-length' at the same time if
you use this feature."
- :group 'which-key
:type '(radio
(const :tag "Do not show docstrings" nil)
(const :tag "Add docstring to command names" t)
`which-key-highlighted-command-face' for any matching names. If
the element is a cons cell, it should take the form (regexp .
face to apply)."
- :group 'which-key
:type '(repeat (choice string (cons regexp face)))
:version "1.0")
is disabled by default. An example configuration is
\(setq which-key-special-keys \\='(\"SPC\" \"TAB\" \"RET\" \"ESC\" \"DEL\")\)"
- :group 'which-key
:type '(repeat string)
:version "1.0")
(defcustom which-key-buffer-name " *which-key*"
"Name of which-key buffer."
- :group 'which-key
:type 'string
:version "1.0")
"Whether to and where to display the current prefix sequence.
Possible choices are echo for echo area (the default), left, top
and nil. Nil turns the feature off."
- :group 'which-key
:type '(radio (const :tag "Left of the keys" left)
(const :tag "In the first line" top)
(const :tag "In the last line" bottom)
(defcustom which-key-popup-type 'side-window
"Supported types are minibuffer, side-window, frame, and custom."
- :group 'which-key
:type '(radio (const :tag "Show in minibuffer" minibuffer)
(const :tag "Show in side window" side-window)
(const :tag "Show in popup frame" frame)
(defcustom which-key-min-display-lines 1
"Minimum number of horizontal lines to display in the which-key buffer."
- :group 'which-key
:type 'integer
:version "1.0")
(defcustom which-key-max-display-columns nil
"Maximum number of columns to display in the which-key buffer.
A value of nil means don't impose a maximum."
- :group 'which-key
:type '(choice integer (const :tag "Unbounded" nil))
:version "1.0")
a list of two locations, like (right bottom). In this case, the
first location is tried. If there is not enough room, the second
location is tried."
- :group 'which-key
:type '(radio (const right)
(const bottom)
(const left)
preceding (that is, above or on the left of) the middle slot. A
positive value means use a slot following (that is, below or on
the right of) the middle slot. The default is zero."
- :group 'which-key
:type 'integer
:version "1.0")
"Maximum width of which-key popup when type is side-window.
This variable can also be a number between 0 and 1. In that case,
it denotes a percentage out of the frame's width."
- :group 'which-key
:type 'float
:version "1.0")
"Maximum height of which-key popup when type is side-window.
This variable can also be a number between 0 and 1. In that case, it denotes
a percentage out of the frame's height."
- :group 'which-key
:type 'float
:version "1.0")
(defcustom which-key-frame-max-width 60
"Maximum width of which-key popup when type is frame."
- :group 'which-key
:type 'integer
:version "1.0")
(defcustom which-key-frame-max-height 20
"Maximum height of which-key popup when type is frame."
- :group 'which-key
:type 'integer
:version "1.0")
See https://github.com/justbur/emacs-which-key/issues/130
and https://github.com/justbur/emacs-which-key/issues/225."
- :group 'which-key
:type 'boolean
:version "1.0")
(defcustom which-key-show-remaining-keys nil
"Show remaining keys in last slot, when keys are hidden."
- :group 'which-key
:type '(radio (const :tag "Yes" t)
(const :tag "No" nil))
:version "1.0")
See the README and the docstrings for those functions for more
information."
- :group 'which-key
:type '(choice (function-item which-key-key-order)
(function-item which-key-key-order-alpha)
(function-item which-key-description-order)
"If non-nil, uppercase comes before lowercase in sorting.
This applies to the function chosen in
`which-key-sort-order'. Otherwise, the order is reversed."
- :group 'which-key
:type 'boolean
:version "1.0")
(defcustom which-key-paging-prefixes '()
"Enable paging for these prefixes."
- :group 'which-key
:type '(repeat string)
:version "1.0")
(defcustom which-key-paging-key "<f5>"
"Key to use for changing pages.
Bound after each of the prefixes in `which-key-paging-prefixes'"
- :group 'which-key
:type 'string
:version "1.0")
Normally `help-char' after a prefix calls
`describe-prefix-bindings'. This changes that command to a
which-key paging command when which-key-mode is active."
- :group 'which-key
:type 'boolean
:version "1.0")
Note that `which-key-idle-delay' should be set before turning on
`which-key-mode'."
- :group 'which-key
:type 'boolean
:version "1.0")
(defcustom which-key-is-verbose nil
"Whether to warn about potential mistakes in configuration."
- :group 'which-key
:type 'boolean
:version "1.0")
prevents which-key from changing window position of visible
buffers. Only takken into account when popup type is
side-window."
- :group
- 'which-key
:type 'boolean
:version "1.0")
of terminals issue META modifier for the Alt key.
See http://www.gnu.org/software/emacs/manual/html_node/emacs/Modifier-Keys.html"
- :group 'which-key
:type 'boolean
:version "1.0")
The delay time is effectively added to the normal
`which-key-idle-delay'."
- :group 'which-key
:type '(repeat function)
:version "1.0")
When non-nil, for a key sequence to trigger the which-key popup
it must match one of the regexps in this list. The format of the
key sequences is what is produced by `key-description'."
- :group 'which-key
:type '(repeat regexp)
:version "1.0")
When non-nil, for a key sequence to trigger the which-key popup
it cannot match one of the regexps in this list. The format of
the key sequences is what is produced by `key-description'."
- :group 'which-key
:type '(repeat regexp)
:version "1.0")
More specifically, detect when `overriding-terminal-local-map' is
set (this is the keymap used by `set-transient-map') and display
it."
- :group 'which-key
:type 'boolean
:version "1.0")
;; Hooks
(defcustom which-key-init-buffer-hook '()
"Hook run when which-key buffer is initialized."
- :group 'which-key
:type 'hook
:version "1.0")